home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / il / ilVkView.z / ilVkView
Encoding:
Text File  |  2002-10-03  |  10.2 KB  |  265 lines
  1.  
  2.  
  3.  
  4. iiiillllVVVVkkkkVVVViiiieeeewwww((((3333))))        IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll        iiiillllVVVVkkkkVVVViiiieeeewwww((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      iiiillllVVVVkkkkVVVViiiieeeewwww - statically displays a single ilImage
  10.  
  11.  
  12. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  13.      ilVkComponent
  14.  
  15.  
  16. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  17.      #include <il/ilVkView.h>
  18.  
  19.  
  20. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  21.      This component displays an ilImage in an SSSSggggVVVViiiissssuuuuaaaallllDDDDrrrraaaawwwwiiiinnnnggggAAAArrrreeeeaaaa widget.  An
  22.      XmForm is used as the base widget of the component. The component is
  23.      created as a child of the parent widget specified in the constructor.
  24.      The drawing area is created with a visual to match the attributes
  25.      specified by arguments passed to the constructor. For example, RGB mode
  26.      and Double Buffer mode may be enabled or disabled.
  27.  
  28.      An iiiillllDDDDiiiissssppppllllaaaayyyy object is created to display the image within the drawing
  29.      area.  The ilDisplay object may be accessed to perform additional image
  30.      manipulation.  Several virtual callbacks are provided to handle expose,
  31.      input, map and resize events. The default implementation of these
  32.      callbacks may be overridden by a derived class.
  33.  
  34. CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
  35.      CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr
  36.  
  37.           ilVkView(const char* name, Widget parent)
  38.           ilVkView(const char* name)
  39.           ilVkView(const char* name, Widget parent, int attributes,
  40.                    int minComponentSize=8, int maxComponentSize=0)
  41.  
  42.      GGGGeeeetttt////sssseeeetttt mmmmeeeetttthhhhooooddddssss
  43.  
  44.           void create(Widget parent)
  45.           const char * className()
  46.           void getSize(int& width, int& height)
  47.           Widget getDrawArea()
  48.           ilDisplay* getDisplay()
  49.           void paint()
  50.           virtual void expose(Widget, XtPointer)  _p_r_o_t_e_c_t_e_d
  51.           virtual void input(Widget, XtPointer)   _p_r_o_t_e_c_t_e_d
  52.           virtual void resize(Widget, XtPointer)  _p_r_o_t_e_c_t_e_d
  53.           virtual void map(Widget, XEvent*, Boolean*)  _p_r_o_t_e_c_t_e_d
  54.           virtual void ilUpdateWidget() _p_r_o_t_e_c_t_e_d
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. iiiillllVVVVkkkkVVVViiiieeeewwww((((3333))))        IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll        iiiillllVVVVkkkkVVVViiiieeeewwww((((3333))))
  71.  
  72.  
  73.  
  74. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  75.      iiiillllVVVVkkkkVVVViiiieeeewwww(((())))
  76.  
  77.           ilVkView(const char* name)
  78.           ilVkView(const char* name, Widget parent)
  79.           ilVkView(const char* name, Widget parent, int attributes,
  80.                    int minComponentSize=8, int maxComponentSize=0)
  81.  
  82.  
  83.           The first version of the constructor simply takes the name of the
  84.           component.  The name of the object is initialized to the name
  85.           specified.
  86.  
  87.           The second and third versions of the constructor take the name of
  88.           the component and also a pointer to the parent widget.  The
  89.           component is created as a child of the specified parent widget.
  90.  
  91.           In the third version three parameters allow the attributes of the
  92.           chosen visual to be specified (see the ffffiiiinnnnddddVVVViiiissssuuuuaaaallllBBBByyyyAAAAttttttttrrrr method of
  93.           iiiillllHHHHwwwwCCCCoooonnnnnnnneeeeccccttttiiiioooonnnn(3) for more information).  This visual is then used
  94.           to create the SgVisualDrawingArea widget in which the images are
  95.           displayed.
  96.  
  97.      ccccllllaaaassssssssNNNNaaaammmmeeee(((())))
  98.  
  99.           const char * className()
  100.  
  101.  
  102.           Returns the name of the class. See VkComponent for more information.
  103.  
  104.      ccccrrrreeeeaaaatttteeee(((())))
  105.  
  106.           void create(Widget parent)
  107.  
  108.  
  109.           Creates the component as a child of _p_a_r_e_n_t.
  110.  
  111.      eeeexxxxppppoooosssseeee(((())))
  112.  
  113.           virtual void expose(Widget, XtPointer)  _p_r_o_t_e_c_t_e_d
  114.  
  115.  
  116.           This virtual method is called by the expose callback when the
  117.           component is exposed. The contents of the drawing area are redrawn
  118.           by calling the redraw method on ilDisplay.
  119.  
  120.      ggggeeeettttDDDDiiiissssppppllllaaaayyyy(((())))
  121.  
  122.           ilDisplay* getDisplay()
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. iiiillllVVVVkkkkVVVViiiieeeewwww((((3333))))        IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll        iiiillllVVVVkkkkVVVViiiieeeewwww((((3333))))
  137.  
  138.  
  139.  
  140.           Returns a pointer to the ilDisplay object used to display the
  141.           ilImage within the drawing area. The image may be manipulated using
  142.           methods on ilDisplay. See iiiillllDDDDiiiissssppppllllaaaayyyy for more information.
  143.  
  144.      ggggeeeettttDDDDrrrraaaawwwwAAAArrrreeeeaaaa(((())))
  145.  
  146.           Widget getDrawArea()
  147.  
  148.  
  149.           Returns the SgVisualDrawingArea widget used to display the image.
  150.           See SSSSggggVVVViiiissssuuuuaaaallllDDDDrrrraaaawwwwiiiinnnnggggAAAArrrreeeeaaaa for more information.
  151.  
  152.      ggggeeeettttSSSSiiiizzzzeeee(((())))
  153.  
  154.           void getSize(int& width, int& height)
  155.  
  156.  
  157.           Returns the current size of the drawing area as width and height.
  158.  
  159.      iiiillllUUUUppppddddaaaatttteeeeWWWWiiiiddddggggeeeetttt(((())))
  160.  
  161.           virtual void ilUpdateWidget() _p_r_o_t_e_c_t_e_d
  162.  
  163.  
  164.           This virtual method is called by sssseeeettttIIIImmmmaaaaggggeeee(). It creates the
  165.           ilDisplay object within the SgVisualDrawingArea widget.
  166.  
  167.      iiiinnnnppppuuuutttt(((())))
  168.  
  169.           virtual void input(Widget, XtPointer)   _p_r_o_t_e_c_t_e_d
  170.  
  171.  
  172.           This virtual method is called by the input callback when X input
  173.           events are received. Since this component statically displays an
  174.           ilImage, no actions are performed in response to input events.
  175.           However, a derived class may choose to manipulate the image within
  176.           the ilDisplay object in response to input events. See also
  177.           iiiillllVVVVkkkkVVVViiiieeeewwwweeeerrrr.
  178.  
  179.      mmmmaaaapppp(((())))
  180.  
  181.           virtual void map(Widget, XEvent*, Boolean*)  _p_r_o_t_e_c_t_e_d
  182.  
  183.  
  184.           This virtual method is by the map callback when X map notify events
  185.           are received.
  186.  
  187.      ppppaaaaiiiinnnntttt(((())))
  188.  
  189.           void paint()
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. iiiillllVVVVkkkkVVVViiiieeeewwww((((3333))))        IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll        iiiillllVVVVkkkkVVVViiiieeeewwww((((3333))))
  203.  
  204.  
  205.  
  206.           Calling this method will cause the image view to be re-painted.
  207.  
  208.      rrrreeeessssiiiizzzzeeee(((())))
  209.  
  210.           virtual void resize(Widget, XtPointer)  _p_r_o_t_e_c_t_e_d
  211.  
  212.  
  213.           This virtual method is called by the resize callback when the
  214.           component is resized. It updates the current size of the drawing
  215.           area.
  216.  
  217. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  218.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllVVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt
  219.      className(), getImage(), getParent(), ilUpdateWidget(), setImage(),
  220.      setParent()
  221.  
  222.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt
  223.      afterRealizeHook(), baseWidget(), className(), getResources(), hide(),
  224.      installDestroyHandler(), manage(), name(), okToQuit(), operator Widget(),
  225.      removeDestroyHandler(), setDefaultResources(), show(), unmanage(),
  226.      widgetDestroyed()
  227.  
  228.  
  229. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  230.      VkComponent, ilVkComponent, ilDisplay
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.